// Copyright 2019 ETH Zürich, Thomas Schöps
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

#pragma once

#include <vector>

#include <libvis/libvis.h>
#include <libvis/image.h>

namespace vis {

class SettingsWindow;

/// Represents a combination of an attached camera and a library which can
/// retrieve its images.
struct AvailableInput {
  enum class Type {
    // Values must start from 0 and increase sequentially
    V4L2 = 0,
    RealSense,
    Structure,
    
    NumTypes
  };
  
  virtual ~AvailableInput() = default;
  
  /// User-friendly name of this input ("Library: camera_name")
  QString display_text;
  
  /// Library which would be used for this input
  Type type;
};

/// Base class for classes that use the input images.
class ImageConsumer : public QObject {
 Q_OBJECT
 public:
  virtual ~ImageConsumer() = default;
  
  virtual void NewImageset(const vector<Image<Vec3u8>>& images) = 0;
};

/// Base class for image providers, such as reading images from disk or acquiring them from a webcam.
class ImageInput {
 public:
  virtual ~ImageInput() = default;
  
  /// Creates an ImageInput for the given AvailableInputs and settings, with the
  /// given consumer. If no suitable ImageInput can be constructed, returns nullptr.
  static ImageInput* CreateForInputs(ImageConsumer* consumer, vector<shared_ptr<AvailableInput>>* inputs, SettingsWindow* settings_window);
};

}
